[docs] improve docs for gtk_accelerator_parse().
authorStefan Kost <ensonic@users.sf.net>
Fri, 16 Apr 2010 18:26:25 +0000 (21:26 +0300)
committerStefan Kost <ensonic@users.sf.net>
Fri, 16 Apr 2010 18:30:47 +0000 (21:30 +0300)
Link to gdk_keyval_from_name() and give example for non obvious accelerator
strings.

gtk/gtkaccelgroup.c

index d5d9b53a96e76f526f91198bd08acb3a98bd0ad3..9dbab6f58604e2a6e9128ff37c6d2ba594014c11 100644 (file)
@@ -1131,6 +1131,9 @@ is_hyper (const gchar *string)
  * "&lt;Release&gt;z" (the last one is for key release).
  * The parser is fairly liberal and allows lower or upper case,
  * and also abbreviations such as "&lt;Ctl&gt;" and "&lt;Ctrl&gt;".
+ * Key names are parsed using gdk_keyval_from_name(). For character keys the
+ * name is not the symbol, but the lowercase name, e.g. one would use
+ * "&lt;Ctrl&gt;minus" instead of "&lt;Ctrl&gt;-".
  *
  * If the parse fails, @accelerator_key and @accelerator_mods will
  * be set to 0 (zero).